/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.service.client.impl;

import java.util.Properties;

import cgl.narada.event.TemplateInfo;
import cgl.narada.event.TemplateProfileAndSynopsisTypes;
import cgl.narada.event.impl.TemplateInfoImpl;
import cgl.narada.matching.Profile;
import cgl.narada.matching.integer.IntegerProfile;
import cgl.narada.matching.regex.RegExProfile;
import cgl.narada.matching.string.StringProfile;
import cgl.narada.matching.tagvaluepairs.TagValueProfile;
import cgl.narada.matching.xmlxpath.XPathProfile;
import cgl.narada.service.ServiceException;
import cgl.narada.service.client.ClientService;
import cgl.narada.service.client.ConnectionLossListener;
import cgl.narada.service.client.EventConsumer;
import cgl.narada.service.client.EventProducer;
import cgl.narada.service.client.NBEventListener;
import cgl.narada.service.client.NBNotificationListener;
import cgl.narada.service.qos.impl.QosServiceImpl;
import cgl.narada.service.replay.EntityReplayActuator;
import cgl.narada.service.replay.ReplayRequest;

/**
 * This class provides a set of core functions that are utilized by applications
 * 
 * @author Shrideep Pallickara $Date$ $Revision$
 */

public class ClientServiceImpl implements ClientService {

    private String moduleName = "ClientServiceImpl: ";

    private QosServiceImpl qosServiceImpl;

    private int entityId;

    private boolean initialized = false;

    private ConnectionLossListener connLossListener;

    public ClientServiceImpl(int entityId, QosServiceImpl qosServiceImpl) {
        this.qosServiceImpl = qosServiceImpl;
        this.entityId = entityId;
        this.connLossListener = null;
    }

    public int getEntityId() {
        return entityId;
    }

    public boolean isInitialized() {
        return initialized;
    }

    public void initializeBrokerCommunications(Properties props, String commType)
        throws ServiceException {

        // HG: Added ...to prevent duplicate connection links..
        if (!initialized) {
            qosServiceImpl.initializeBrokerCommunications(entityId, props,
                                                          commType);
        }
        
        if (commType.equals("ipsec")) {
            return;
        }
        initialized = true;

    }

    public void setCommunicationLossListener(
                                             ConnectionLossListener connLossListener) {
        qosServiceImpl.setConnLossListener(connLossListener);
    }

    /** Creates a profile */
    public Profile createProfile(int type, Object subscription)
        throws ServiceException {
        String profileId = subscription.toString() + "<>" + entityId;
        return createProfile(type, profileId, subscription);
    }

    /** Creates a profile */
    public Profile createProfile(int type, String profileId, Object subscription)
        throws ServiceException {
        Profile profile = null;

        if (type == TemplateProfileAndSynopsisTypes.STRING) {
            profile = new StringProfile((String) subscription, entityId,
                                        profileId);
        }

        if (type == TemplateProfileAndSynopsisTypes.INTEGER) {
            profile = new IntegerProfile((Integer) subscription, entityId,
                                         profileId);
        }

        if (type == TemplateProfileAndSynopsisTypes.XML) {
            profile = new XPathProfile((String) subscription, entityId,
                                       profileId);
        }

        if (type == TemplateProfileAndSynopsisTypes.REGULAR_EXPRESSIONS) {
            profile = new RegExProfile((String) subscription, entityId,
                                       profileId);
        }

        if (type == TemplateProfileAndSynopsisTypes.TAG_VALUE_PAIRS) {
            profile = new TagValueProfile((String) subscription, entityId,
                                          profileId);
        }

        if (profile == null) {
            throw new ServiceException(moduleName
                + "Unknown profile type specified");
        }

        return profile;

    }

    public QosServiceImpl getQosServiceImpl() {
        return qosServiceImpl;
    }

    /** Creates a template info */
    public TemplateInfo createTemplateInfo(int templateId, int templateType,
                                           Object template)
        throws ServiceException {
        TemplateInfo templateInfo = null;

        if (template == null) {
            throw new ServiceException(moduleName
                + "Specified template is NULL");
        }

        if (templateType == TemplateProfileAndSynopsisTypes.STRING
            || templateType == TemplateProfileAndSynopsisTypes.INTEGER
            || templateType == TemplateProfileAndSynopsisTypes.XML
            || templateType == TemplateProfileAndSynopsisTypes.REGULAR_EXPRESSIONS
            || templateType == TemplateProfileAndSynopsisTypes.TAG_VALUE_PAIRS) {
            templateInfo = new TemplateInfoImpl(templateId, templateType,
                                                template);
        }

        if (templateInfo == null) {
            throw new ServiceException(moduleName
                + "Unknown template type specified");
        }

        return templateInfo;

    }

    /** Creates a template info */
    public TemplateInfo createTemplateInfo(int templateId, int templateType,
                                           Object template,
                                           Object allEncompassingConstraint)
        throws ServiceException {
        TemplateInfo templateInfo = null;

        if (template == null || allEncompassingConstraint == null) {
            throw new ServiceException(moduleName + "Specified template = "
                + template + "Encompasssing constraint = "
                + allEncompassingConstraint);
        }

        if (templateType == TemplateProfileAndSynopsisTypes.STRING
            || templateType == TemplateProfileAndSynopsisTypes.INTEGER
            || templateType == TemplateProfileAndSynopsisTypes.INTEGER
            || templateType == TemplateProfileAndSynopsisTypes.REGULAR_EXPRESSIONS
            || templateType == TemplateProfileAndSynopsisTypes.TAG_VALUE_PAIRS) {
            templateInfo = new TemplateInfoImpl(templateId, templateType,
                                                template,
                                                allEncompassingConstraint);
        }

        if (templateInfo == null) {
            throw new ServiceException(moduleName
                + "Unknown template type specified");
        }

        return templateInfo;
    }

    public EventConsumer createEventConsumer(NBEventListener listener)
        throws ServiceException {
        if (listener == null) {
            throw new ServiceException(moduleName
                + "Specified NBEventListener is NULL");
        }
        int consumerId = qosServiceImpl.generateConsumerId();
        EventConsumerImpl consumer = new EventConsumerImpl(entityId,
                                                           consumerId,
                                                           qosServiceImpl);
        consumer.setNBEventListener(listener);
        qosServiceImpl.registerConsumer(consumerId, consumer);
        return consumer;
    }

    public EventConsumer createEventConsumer(
                                             NBEventListener listener,
                                             NBNotificationListener notificationListener)
        throws ServiceException {
        if (listener == null) {
            throw new ServiceException(moduleName
                + "Specified NBEventListener is NULL");
        }

        if (notificationListener == null) {
            throw new ServiceException(moduleName
                + "Specified NBNotificationListener is NULL");
        }
        int consumerId = qosServiceImpl.generateConsumerId();
        EventConsumerImpl consumer = new EventConsumerImpl(entityId,
                                                           consumerId,
                                                           qosServiceImpl);
        consumer.setNBEventListener(listener);
        consumer.setNBNotificationListener(notificationListener);
        qosServiceImpl.registerConsumer(consumerId, consumer);
        return consumer;
    }

    public EventProducer createEventProducer() throws ServiceException {
        int producerId = qosServiceImpl.generateProducerId();
        EventProducerImpl producer = new EventProducerImpl(entityId,
                                                           producerId,
                                                           qosServiceImpl);
        qosServiceImpl.registerProducer(producerId, producer);
        return producer;
    }

    public EventProducer createEventProducer(
                                             NBNotificationListener notificationListener)
        throws ServiceException {
        int producerId = qosServiceImpl.generateProducerId();
        EventProducerImpl producer = new EventProducerImpl(entityId,
                                                           producerId,
                                                           qosServiceImpl);
        producer.setNBNotificationListener(notificationListener);
        qosServiceImpl.registerProducer(producerId, producer);
        return producer;
    }

    public ReplayRequest createReplayRequest(int templateId,
                                             long[] sequencesToReplay)
        throws ServiceException {
        EntityReplayActuator entityReplayActuator = cgl.narada.service.replay.impl.EntityReplayActuatorImpl
            .getInstance();
        ReplayRequest replayRequest = entityReplayActuator
            .createReplayRequest(templateId, entityId, sequencesToReplay);
        return replayRequest;
    }

    /** Create a replay request based on the specified range */
    public ReplayRequest createReplayRequest(int templateId,
                                             long sequenceStart,
                                             long sequenceEnd)
        throws ServiceException {
        EntityReplayActuator entityReplayActuator = cgl.narada.service.replay.impl.EntityReplayActuatorImpl
            .getInstance();
        ReplayRequest replayRequest = entityReplayActuator
            .createReplayRequest(templateId, entityId, sequenceStart,
                                 sequenceEnd);
        return replayRequest;

    }

    /** Create a replay request based on the specified constraints */
    public ReplayRequest createReplayRequest(int templateId,
                                             long sequenceStart,
                                             long sequenceEnd,
                                             Profile[] specifiedConstraints)
        throws ServiceException {
        EntityReplayActuator entityReplayActuator = cgl.narada.service.replay.impl.EntityReplayActuatorImpl
            .getInstance();
        ReplayRequest replayRequest = entityReplayActuator
            .createReplayRequest(templateId, entityId, sequenceStart,
                                 sequenceEnd, specifiedConstraints);
        return replayRequest;
    }

    /**
     * Signoff. All communications resources including the connection to the
     * broker are released
     */
    public void closeBrokerConnection() throws ServiceException {
        qosServiceImpl.closeBrokerConnection();
    }

    /** Terminate services that are currently running within the JVM */
    public void terminateServices() throws ServiceException {
        qosServiceImpl.terminateServices();
        initialized = false;
    }

    public boolean hasPendingTransfers() throws ServiceException {
        return qosServiceImpl.hasPendingTransfers();
    }
}
